fix(lib): Update README and CLI for improved clarity#21
Merged
Conversation
The README and CLI documentation have been revised to enhance clarity regarding the setup process. The instructions now specify that the setup should be performed from the app directory where `@verndale/ai-commit` is installed, rather than the git repository root. This change aims to prevent confusion, especially in monorepo setups. Additionally, the CLI command descriptions have been updated to better reflect the behavior of the `init` command and its flags. These improvements will help users understand the expected outcomes and the structure of the environment files more clearly. No issue references detected.
|
🎉 This PR is included in version 2.5.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
fix(lib): Update README and CLI for improved clarity
Summary (AI, bounded)
Changes
Files changed
MREADME.mdMbin/cli.jsMlib/core/git.jsMlib/init-env.jsAlib/init-paths.jsMlib/init-workspace.jsDiff stats
Testing
Risk / Impact
Base:
main→ Head:feat/det-installSuggested labels / Review checklist
Suggested labels: docs, cli, lib, enhancement
Review checklist: